index
/api/v1/accounts/:account_id/customers/:customer_id/customer_cards
List customer cards
Returns all loyalty cards enrolled for a specific customer, including stamp progress, status, wallet pass installation state, and wallet pass URLs (apple_wallet_url and google_wallet_url) that you can use to let customers add their loyalty card to Apple Wallet or Google Wallet from your own app or website.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id
|
Must be a number. | Required |
Store (account) ID |
customer_id
|
Must be a number. | Required |
Customer ID |
Error Codes
| Code | Description |
|---|---|
401
|
Unauthorized – invalid or missing API token |
404
|
Store or customer not found |
Returns
Code: 200
An array of the customer's loyalty cards
| Name | Type | Required | Description |
|---|---|---|---|
id
|
Must be a Integer | Required |
Customer card ID |
card_id
|
Must be a Integer | Required |
Loyalty card template ID |
card_name
|
Must be a String | Required |
Name of the loyalty card |
stamps_count
|
Must be a Integer | Required |
Stamps collected so far |
stamps_remaining
|
Must be a Integer | Required |
Stamps still needed to complete the card |
status
|
Must be a String | Required |
Current state of the customer card |
uuid
|
Must be a String | Required |
Public identifier used in wallet pass URLs |
progress_percentage
|
Must be a Integer | Required |
Completion towards the next reward, 0 to 100 |
pass_installed
|
Must be one of: true, false, 1, 0.
|
Required |
Whether the wallet pass has been installed |
apple_wallet_url
|
Must be a String | Required |
Link to add or view the pass in Apple Wallet |
google_wallet_url
|
Must be a String | Required |
Link to add or view the pass in Google Wallet |
issued_at
|
Must be a String | Required |
ISO 8601 timestamp the card was issued (nil allowed) |
created_at
|
Must be a String | Required |
ISO 8601 creation timestamp |
updated_at
|
Must be a String | Required |
ISO 8601 last-update timestamp |